home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / error.n < prev    next >
Text File  |  1994-09-20  |  2KB  |  67 lines
  1.  
  2.  
  3.  
  4. error(n)              Tcl Built-In Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      error - Generate an error
  12.  
  13. SYNOPSIS
  14.      error _m_e_s_s_a_g_e ?_i_n_f_o? ?_c_o_d_e?
  15. _________________________________________________________________
  16.  
  17.  
  18. DESCRIPTION
  19.      Returns a TCL_ERROR code, which causes  command  interpreta-
  20.      tion to be unwound.  _M_e_s_s_a_g_e is a string that is returned to
  21.      the application to indicate what went wrong.
  22.  
  23.      If the _i_n_f_o argument is provided and  is  non-empty,  it  is
  24.      used to initialize the global variable errorInfo.  errorInfo
  25.      is used to accumulate a stack trace of what was in  progress
  26.      when  an  error occurred; as nested commands unwind, the Tcl
  27.      interpreter adds information  to  errorInfo.   If  the  _i_n_f_o
  28.      argument  is present, it is used to initialize errorInfo and
  29.      the first increment of unwind information will not be  added
  30.      by  the  Tcl  interpreter.  In other words, the command con-
  31.      taining the error command will not appear in  errorInfo;  in
  32.      its place will be _i_n_f_o.  This feature is most useful in con-
  33.      junction with the catch command: if a caught error cannot be
  34.      handled  successfully,  _i_n_f_o  can  be used to return a stack
  35.      trace reflecting the original point  of  occurrence  of  the
  36.      error:
  37.  
  38.           catch {...} errMsg
  39.           set savedInfo $errorInfo
  40.           ...
  41.           error $errMsg $savedInfo
  42.  
  43.  
  44.      If the _c_o_d_e argument is present, then its value is stored in
  45.      the errorCode global variable.  This variable is intended to
  46.      hold a machine-readable description of the  error  in  cases
  47.      where  such information is available; see the section BUILT-
  48.      IN VARIABLES below for information on the proper format  for
  49.      the  variable.   If  the  _c_o_d_e argument is not present, then
  50.      errorCode is automatically reset  to  ``NONE''  by  the  Tcl
  51.      interpreter as part of processing the error generated by the
  52.      command.
  53.  
  54.  
  55. KEYWORDS
  56.      error, errorCode, errorInfo
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Tcl                                                             1
  64.  
  65.  
  66.  
  67.